Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Boost: Add tracks event to clickable events on settings page #40246

Open
wants to merge 15 commits into
base: trunk
Choose a base branch
from
Open

Boost: Add tracks event to clickable events on settings page #40246

wants to merge 15 commits into from
+51 −3

Conversation

donnchawp
Copy link
Contributor

@donnchawp donnchawp commented Nov 19, 2024 •
edited
Loading

Some clickable events on the settings page do not have a Tracks event, this PR will add them.

Fixes #28192

Proposed changes:

  • Add a function, handleClickRegenerate, to critical css module to handle toggling the meta of that module, and record a Tracks event, critical_css_regenerate_clicked
  • Add a new parameter tracksEventName to CollapsibleMeta, and use that to record toggling the meta module of the ImageCDN Quality settings.
  • Add a new Tracks event, page_cache_clear_clicked when "Clear Cache" is clicked.
  • Add a new Tracks event, page_cache_exceptions_save_clicked when page cache exceptions are saved.
  • Add a new Tracks event, page_cache_see_example_clicked when "See and example" is clicked.
  • Add a new Tracks event, speed_score_refresh_clicked when the speed score Refresh button is clicked.
  • Add a new Tracks event, support_contact_us_clicked when the "Contact Us" button is clicked.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

pc9hqz-3dv-p2

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Apply patch.
  • Edit app/assets/src/js/lib/utils/analytics.ts and modify recordBoostEvent() so it logs to the browser with console.log()
  • Test clicking all the buttons and links on the settings page and watch the events show up in the web console.

@donnchawp donnchawp added [Status] In Progress [Plugin] Boost A feature to speed up the site and improve performance. labels Nov 19, 2024
@donnchawp donnchawp self-assigned this Nov 19, 2024
@github-actions GitHub Actions
Copy link
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Boost plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@donnchawp donnchawp changed the title Boost: Add tracks event to clicking of speed score refresh Boost: Add tracks event to clickable events on settings page Nov 19, 2024
dilirity
dilirity requested changes Nov 20, 2024
View reviewed changes
Copy link
Member

@dilirity dilirity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are some suggestions and a couple of places that are missing events. I haven't listed all of them, only the ones I could find at a glance. There's probably more.

Missing events:

Critical CSS link in the Cloud/Critical CSS description -

jetpack/projects/plugins/boost/app/assets/src/js/pages/index/index.tsx

Line 56 in 2be2a29

link: <a href={ criticalCssLink } target="_blank" rel="noopener noreferrer" />,

Defer JS link -

jetpack/projects/plugins/boost/app/assets/src/js/pages/index/index.tsx

Line 139 in 2be2a29

link: <a href={ deferJsLink } target="_blank" rel="noopener noreferrer" />,

Contact Support link -

jetpack/projects/plugins/boost/app/assets/src/js/features/critical-css/show-stopper-error/show-stopper-error.tsx

Line 207 in 4e1fe65

{ __( 'Contact Support', 'jetpack-boost' ) }

Clicking the "back" button on the ISA report page.

I'm not sure if the "Score changed" popup has any events attached to its elements -

jetpack/projects/plugins/boost/app/assets/src/js/features/speed-score/pop-out/pop-out.tsx

Line 56 in 52e1876

function PopOut( { scoreChange }: Props ) {

projects/plugins/boost/changelog/update-boost-add-tracks-events Outdated Show resolved Hide resolved
projects/plugins/boost/app/assets/src/js/features/page-cache/meta/meta.tsx Outdated Show resolved Hide resolved
...cts/plugins/boost/app/assets/src/js/features/image-cdn/quality-settings/quality-settings.tsx Outdated Show resolved Hide resolved
@donnchawp
Copy link
Contributor Author

The deferJsLink and criticalCssLink links don't need tracking as they are redirects on jetpack.com

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dilirity dilirity dilirity requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@donnchawp donnchawp

Labels
[Plugin] Boost A feature to speed up the site and improve performance. [Status] In Progress
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Enhancement: Add tracks for all boost interactions
2 participants
@donnchawp @dilirity